IMotion.GetGroupParameter method

Gets the value of a parameter from an axis group. The returned value has to be converted to double if necessary. The parameters are defined in McGroupParameter.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsReturn<double> GetGroupParameter(
       int Index,
       McGroupParameter ParameterNumber
)

Function GetGroupParameter(
       Index As Integer,
       ParameterNumber As McGroupParameter
) As KsReturn(Of Double)

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

ParameterNumber [in]

Type: McGroupParameter

A parameter from McGroupParameter.

Return value

Type: KsReturn<double>

Returns a KsError code and a double value.

Examples

N/A